//
// MudTools.OfficeInterop 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
//
// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
//
// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！

namespace MudTools.OfficeInterop.Word;


/// <summary>
/// Word 查找接口
/// </summary>
public interface IWordFind : IDisposable
{
    /// <summary>
    /// 获取应用程序对象。
    /// </summary>
    IWordApplication? Application { get; }

    /// <summary>
    /// 获取父对象。
    /// </summary>
    object Parent { get; }

    /// <summary>
    /// 获取或设置查找文本
    /// </summary>
    string FindText { get; set; }

    /// <summary>
    /// 获取或设置替换文本
    /// </summary>
    string ReplaceWith { get; set; }

    /// <summary>
    /// 获取或设置是否区分大小写
    /// </summary>
    bool MatchCase { get; set; }

    /// <summary>
    /// 获取或设置是否全字匹配
    /// </summary>
    bool MatchWholeWord { get; set; }

    /// <summary>
    /// 获取或设置是否使用通配符
    /// </summary>
    bool MatchWildcards { get; set; }

    /// <summary>
    /// 获取或设置是否匹配前缀
    /// </summary>
    bool MatchPrefix { get; set; }

    /// <summary>
    /// 获取或设置是否匹配后缀
    /// </summary>
    bool MatchSuffix { get; set; }

    /// <summary>
    /// 获取或设置是否忽略空格
    /// </summary>
    bool IgnoreSpace { get; set; }

    /// <summary>
    /// 获取或设置是否忽略标点符号
    /// </summary>
    bool IgnorePunct { get; set; }

    /// <summary>
    /// 获取或设置查找包装方式
    /// </summary>
    WdFindWrap Wrap { get; set; }

    /// <summary>
    /// 执行查找
    /// </summary>
    /// <returns>是否找到</returns>
    bool Execute();

    /// <summary>
    /// 执行查找并替换
    /// </summary>
    /// <param name="replace">替换选项</param>
    /// <returns>是否找到并替换</returns>
    bool ExecuteReplace(int replace = 2);

    /// <summary>
    /// 清除查找设置
    /// </summary>
    void ClearFormatting();

    /// <summary>
    /// 清除替换设置
    /// </summary>
    void ClearReplaceFormatting();
}
